
<!DOCTYPE html>

<html>
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>ONU simulator and test client &#8212; onusim  documentation</title>
    <link rel="stylesheet" href="_static/nature.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <link rel="stylesheet" type="text/css" href="_static/extra.css" />
    <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
    <script src="_static/jquery.js"></script>
    <script src="_static/underscore.js"></script>
    <script src="_static/doctools.js"></script>
    <script src="_static/language_data.js"></script>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="1. Introduction" href="usage/introduction.html" /> 
  </head><body>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="usage/introduction.html" title="1. Introduction"
             accesskey="N">next</a> |</li>
        <li class="nav-item nav-item-0"><a href="#">onusim  documentation</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">ONU simulator and test client</a></li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="onu-simulator-and-test-client">
<h1>ONU simulator and test client<a class="headerlink" href="#onu-simulator-and-test-client" title="Permalink to this headline">¶</a></h1>
<div class="section" id="contents">
<h2 class="display-none">Contents<a class="headerlink" href="#contents" title="Permalink to this headline">¶</a></h2>
<p><!-- toctree --></p>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Contents</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="usage/introduction.html">1. Introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="usage/introduction.html#installation">1.1. Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage/introduction.html#onu-simulation-server">1.2. ONU simulation server</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage/introduction.html#onu-test-client">1.3. ONU test client</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage/introduction.html#examples">1.4. Examples</a><ul>
<li class="toctree-l3"><a class="reference internal" href="usage/introduction.html#get">Get</a></li>
<li class="toctree-l3"><a class="reference internal" href="usage/introduction.html#omci_dump_decoder">omci_dump_decoder</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="usage/introduction.html#docker">1.5. Docker</a><ul>
<li class="toctree-l3"><a class="reference internal" href="usage/introduction.html#docker-server-host-client">Docker server, host client</a></li>
<li class="toctree-l3"><a class="reference internal" href="usage/introduction.html#host-server-docker-client">Host server, Docker client</a></li>
<li class="toctree-l3"><a class="reference internal" href="usage/introduction.html#docker-server-docker-client">Docker server, Docker client</a></li>
<li class="toctree-l3"><a class="reference internal" href="usage/introduction.html#with-tr451_polt_simulator-new-using-docker-compose">With tr451_polt_simulator: new (using docker-compose)</a></li>
<li class="toctree-l3"><a class="reference internal" href="usage/introduction.html#with-tr451_polt_simulator-old-not-using-docker-compose">With tr451_polt_simulator: old (not using docker-compose)</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="usage/extensions.html">2. Extensions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="usage/extensions.html#supporting-a-new-mib">2.1. Supporting a new MIB</a><ul>
<li class="toctree-l3"><a class="reference internal" href="usage/extensions.html#obbaa_onusimmibscardholderpy">obbaa_onusim/mibs/cardholder.py</a></li>
<li class="toctree-l3"><a class="reference internal" href="usage/extensions.html#obbaa_onusimdatabasepy-import">obbaa_onusim/database.py (import)</a></li>
<li class="toctree-l3"><a class="reference internal" href="usage/extensions.html#obbaa_onusimdatabasepy-specs">obbaa_onusim/database.py (specs)</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="usage/extensions.html#supporting-a-new-action">2.2. Supporting a new action</a><ul>
<li class="toctree-l3"><a class="reference internal" href="usage/extensions.html#obbaa_onusimactionssoftwarepy">obbaa_onusim/actions/software.py</a></li>
<li class="toctree-l3"><a class="reference internal" href="usage/extensions.html#obbaa_onusimactionsotherpy">obbaa_onusim/actions/other.py</a></li>
<li class="toctree-l3"><a class="reference internal" href="usage/extensions.html#obbaa_onusimmibssoftware_imagepy">obbaa_onusim/mibs/software_image.py</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="bin/index.html">3. Scripts</a><ul>
<li class="toctree-l2"><a class="reference internal" href="bin/index.html#module-bin.onusim">3.1. ONU simulation server</a><ul>
<li class="toctree-l3"><a class="reference internal" href="bin/index.html#module-bin.onusim.argparser Named Arguments">Named Arguments</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="bin/index.html#module-bin.onucli">3.2. ONU test client</a><ul>
<li class="toctree-l3"><a class="reference internal" href="bin/index.html#module-bin.onucli.argparser Positional Arguments">Positional Arguments</a></li>
<li class="toctree-l3"><a class="reference internal" href="bin/index.html#module-bin.onucli.argparser Named Arguments">Named Arguments</a></li>
<li class="toctree-l3"><a class="reference internal" href="bin/index.html#module-bin.onucli.argparser Sub-commands:">Sub-commands:</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="obbaa_onusim/index.html">4. Modules</a><ul>
<li class="toctree-l2"><a class="reference internal" href="obbaa_onusim/index.html#module-obbaa_onusim.endpoint">4.1. Endpoint</a></li>
<li class="toctree-l2"><a class="reference internal" href="obbaa_onusim/index.html#messages-and-actions">4.2. Messages and Actions</a><ul>
<li class="toctree-l3"><a class="reference internal" href="obbaa_onusim/index.html#module-obbaa_onusim.message">Message classes</a></li>
<li class="toctree-l3"><a class="reference internal" href="obbaa_onusim/index.html#module-obbaa_onusim.action">Action classes</a></li>
<li class="toctree-l3"><a class="reference internal" href="obbaa_onusim/index.html#module-obbaa_onusim.actions.set">Set action</a></li>
<li class="toctree-l3"><a class="reference internal" href="obbaa_onusim/index.html#module-obbaa_onusim.actions.get">Get action</a></li>
<li class="toctree-l3"><a class="reference internal" href="obbaa_onusim/index.html#module-obbaa_onusim.actions.upload">MIB upload and  MIB upload next actions</a></li>
<li class="toctree-l3"><a class="reference internal" href="obbaa_onusim/index.html#module-obbaa_onusim.actions.reset">MIB reset action</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="obbaa_onusim/index.html#mibs">4.3. MIBs</a><ul>
<li class="toctree-l3"><a class="reference internal" href="obbaa_onusim/index.html#module-obbaa_onusim.mib">MIB classes</a></li>
<li class="toctree-l3"><a class="reference internal" href="obbaa_onusim/index.html#module-obbaa_onusim.mibs.onu_g">ONU-G MIB</a></li>
<li class="toctree-l3"><a class="reference internal" href="obbaa_onusim/index.html#module-obbaa_onusim.mibs.onu2_g">ONU2-G MIB</a></li>
<li class="toctree-l3"><a class="reference internal" href="obbaa_onusim/index.html#module-obbaa_onusim.mibs.onu_data">ONU data MIB</a></li>
<li class="toctree-l3"><a class="reference internal" href="obbaa_onusim/index.html#module-obbaa_onusim.mibs.software_image">Software image MIB</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="obbaa_onusim/index.html#module-obbaa_onusim.database">4.4. Database</a></li>
<li class="toctree-l2"><a class="reference internal" href="obbaa_onusim/index.html#support">4.5. Support</a><ul>
<li class="toctree-l3"><a class="reference internal" href="obbaa_onusim/index.html#module-obbaa_onusim.types">Types</a></li>
<li class="toctree-l3"><a class="reference internal" href="obbaa_onusim/index.html#module-obbaa_onusim.util">Utilities</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="usage/documentation.html">5. Documentation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="usage/documentation.html#installation">5.1. Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage/documentation.html#invocation">5.2. Invocation</a><ul>
<li class="toctree-l3"><a class="reference internal" href="usage/documentation.html#locally">Locally</a></li>
<li class="toctree-l3"><a class="reference internal" href="usage/documentation.html#in-docker">In docker</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="usage/documentation.html#adding-documentation">5.3. Adding documentation</a><ul>
<li class="toctree-l3"><a class="reference internal" href="usage/documentation.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="usage/documentation.html#python-docstrings">Python docstrings</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="indices-and-tables">
<h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul>
</div>
</div>


            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <h3><a href="#">Table of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">ONU simulator and test client</a><ul>
<li><a class="reference internal" href="#contents">Contents</a></li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>
</li>
</ul>

  <h4>Next topic</h4>
  <p class="topless"><a href="usage/introduction.html"
                        title="next chapter"><span class="section-number">1. </span>Introduction</a></p>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="_sources/index.md.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="usage/introduction.html" title="1. Introduction"
             >next</a> |</li>
        <li class="nav-item nav-item-0"><a href="#">onusim  documentation</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">ONU simulator and test client</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &#169; Copyright 2020, Broadband Forum.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.1.0+.
    </div>
  </body>
</html>